/* ParseCallback.cs -- 
   Copyright (C) 2007, 2008  Casey Marshall
   Copyright (C) 2008 Pacific Biosciences, Inc.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */


namespace SexpSharp
{
    /// <summary>
    /// Callback interface used by s-expression parsers to handle parsed
    /// s-expression values.
    /// </summary>
    public interface ParseCallback
    {

	/// <summary>
	/// Begins a list. In a well-formed s-expression, every call to
	/// this method will be followed by another call to OnListEnd.
	/// </summary>
	void OnListBegin();

	/// <summary>
	/// Ends a list.
	/// </summary>
	void OnListEnd();

	/// <summary>
	/// Begin a multi-part atom. This call will be followed by zero or
	/// more calls to OnAtomData, followed by a final call to
	/// OnAtomEnd. The callback will get atomLength bytes in all calls
	/// to OnAtomData.
	/// </summary>
	///
	/// <param name="atomLength">The length, in bytes, of the atom
	/// being parsed.</param>
	void OnAtomBegin(int atomLength);

	/// <summary>
	/// Update a multi-part atom with more data.
	/// </summary>
	///
	/// <param name="input">The atom bytes.</param>
	void OnAtomData(byte[] input, int offset, int length);

	/// <summary>
	/// End a multi-part atom.
	/// </summary>
	void OnAtomEnd();

	/// <summary>
	/// An atom, in its entirety, was read.
	/// </summary>
	///
	/// <param name="atomBytes">The atom bytes.</param>
	void OnAtom(byte[] atomBytes, int offset, int length);

	/// <summary>
	/// Signals that the end of input was reached.
	/// </summary>
	void OnEndOfInput();
    }
}
